Skip to main content

Update User ExtraField

PUT : http://<base_url>/digipay/v3/user/document_type

This API is used to update new document type into the system

BODY PARAMS:-

ParameterTypeDescriptionValue
idStringunique id assign to user to retrive user extrafield detail2191e668d3794f50b8fe63c3a6556c55
field_titleStringThe title or name of the document type, such as ""Passport"" or ""Driver's License.The title or name of the field, given as ""Sample Field"".Expiry Date
field_typeIntAn integer representing the field type, set to 1. The actual meanings of field types would depend on the application's domain.2
field_descriptionStringDA description of the field, given as ""This is a sample field for demonstration.hello
is_mandatoryBooleanA boolean flag indicating whether the document is mandatory.true/false
user_typeIntAn integer representing the user type associated with the field, set to 2.2
field_keyStringA key or identifier for the field, set as ""sample_key"".123
typeIntAn integer representing a certain type, set to 3. The actual meanings of types would depend on the application's context.2
dynamic_category_keyStringA key that dynamically links documents to specific categories.dynamic_key
display_orderStringsAn integer indicating the display order of the field, set to 5.123
is_defaultBooleanA boolean flag indicating whether an expiry date is required for the document."true/false
parent_field_keyStringsA key representing the parent field, set as ""parent_key".1213

HEADERS:-

ParameterTypeDescriptionValue
AuthorizationStringIt is a combination of type and token to authenticate user for the given tokenToken duik7309njdlkhdauhknksadhjkas986876sd873j
CompanyIDStringCompany_id is a unique primary id, that is represent company detail76bc712200ca444fa334f9e55e5fd7a8

Request Body:-

Request Example
curl --request PUT \
--url http://192.168.1.102:8014/digipay/v3/user/user_extra_field \
--header 'Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NWY0ZDI1MDliZmU0NTBmYTg4MTVhNTU5Njk3YmM0NyIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNjkzNTIxOTU1fQ.9oWwUzlFzmYB1ZOhaVamxKJH6DsMO8tFue2kbg2YyoI' \
--header 'CompanyID: Company_id is a unique primary id, that is represent company detail.' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"id": "2191e668d3794f50b8fe63c3a6556c55",
"field_title": "Expiry Date",
"field_type": 2,
"field_description": "hello",
"is_mandatory": false,
"user_type": 2,
"field_key": "123",
"type": 2,
"dynamic_category_key": "123",
"display_order": "123",
"is_default": false,
"parent_field_key": "1213"
}
'

Response:-

Response 200(OK)

{
"success": 1,
"error": [],
"data": {
"message": "User extra field data updated successfully."
}
}
Response 400(BAD REQUEST)
{
"success": 0,
"error"": [1],
"data": {
"message": "BAD_REQUEST",
}
}

RESPONSES :-

Status CodeDescription
200OK
400BAD REQUEST
404NOT FOUND
500INTERNAL SERVER ERROR